home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1996 November / macformat-043.iso / mac / Shareware Plus / Developers / Sprite Animation Toolkit 2.3.8 / SAT Think Lib ƒ / SAT.p < prev    next >
Encoding:
Text File  |  1996-05-20  |  12.2 KB  |  277 lines  |  [TEXT/PJMM]
  1. unit SAT;
  2.  
  3. interface
  4. {$ifc UNDEFINED THINK_PASCAL}
  5.     uses
  6.         Types, QuickDraw, Icons; {Icons assume UPI}
  7.  
  8. {$PUSH}
  9. {$ALIGN MAC68K}
  10. {$endc}
  11.  
  12.     type
  13.         SATPort = record
  14.                 port: GrafPtr;        {GrafPtr/WindowPtr, use for SetPort, ShowWindow…}
  15.                 device: GDHandle;    {Internal}
  16.                 rows: Ptr;            {Internal}
  17.                 bounds: Rect;            {Internal}
  18.                 baseAddr: Ptr;        {Internal}
  19.                 rowBytes: Integer;    {Internal}
  20.             end;
  21.         SATPortPtr = ^SATPort;
  22.  
  23.         FacePtr = ^Face;
  24.         Face = record
  25.                 colorData: Ptr;
  26.                 resNum: integer;
  27.                 iconMask: BitMap;
  28.                 rowBytes: integer;
  29.                 next: FacePtr;
  30.                 maskRgn: RgnHandle;
  31.                 rows, maskRows: Ptr;
  32.                 redrawProc: ProcPtr;    {Called on depth changes, not needed if loaded from a cicn}
  33.                 drawProc: ProcPtr;        {Called to draw the face (usually nil)}
  34.             end;
  35.  
  36.         SpritePtr = ^Sprite;
  37.         Sprite = record
  38. { Variables that you should change as appropriate }
  39.                 kind: Integer; { Used for identification. >0: friend. <0 foe }
  40.                 position: Point;
  41.                 hotRect, hotRect2: Rect; { Tells how large the sprite is; hotRect is centered around origo }
  42.                                     {hotRect is set by you. hotRect2 is offset to the current position.}
  43.                 face: FacePtr;            { Pointer to the Face (appearance) to be used. }
  44.                 task: ProcPtr;            { Callback-routine, called once per frame. If task=nil, the sprite is removed. }
  45.                 hitTask: ProcPtr;        { Callback in collisions. }
  46.                 destructTask: ProcPtr;    { Called when a sprite is disposed. (Usually nil.) }
  47.                 clip: RgnHandle;            {Clip region to be used when this sprite is drawn.}
  48. { SAT variables that you shouldn't change: }
  49.                 oldpos: Point;                {Used by RunSAT2}
  50.                 next, prev: SpritePtr;    {You may change them in your own sorting routine, but be careful if you do.}
  51.                 r, oldr: Rect;                {Rectangle telling where to draw. Avoid messing with it.}
  52.                 oldFace: FacePtr;            {Used by RunSAT2}
  53.                 dirty: Boolean;            {Used by RunSAT2}
  54. {Variables for internal use by the sprites. Use as you please. Edit as necessary - this is merely a default}
  55. {set, enough space for most cases - but if you change the size of the record, call SetSpriteSize immediately}
  56. {after initializing (before any sprites are created)!}
  57.                 layer: integer; {For layer-sorting. When not used for that, use freely.}
  58.                 speed: Point; { Can be used for speed, but not necessarily. }
  59.                 mode: integer; { Usually used for different modes and/or to determine what image to show next. }
  60.                 appPtr: Ptr; {Pointer for use by the application - i.e. pointer to extra data}
  61.                 appLong: Longint; {Longint for free use by the application.}
  62.             end;
  63.  
  64. {Type for SATs pattern utilities.}
  65.     type
  66.         SATPattern = record
  67.                 patternType: integer; {1 = Pattern, PatHandle, 2 = PixPat, PixPatHandle}
  68.                 thePat: PixPatHandle; {or PatHandle}
  69.             end; {record}
  70.         SATPatPtr = ^SATPattern;
  71.         SATPatHandle = ^SATPatPtr;
  72.  
  73. {Update list. Used internally}
  74.         UpdatePtr = ^UpdateRec;
  75.         UpdateRec = record
  76.                 updateRect: Rect;
  77.                 next: UpdatePtr;
  78.             end;
  79.  
  80. {The globals record. Some fields are important for you. These are marked with *}
  81.         SATglobalsRec = record
  82.                 wind: SATPort;                                {*The window that SAT draws in. You get the WindowPtr as gSAT.wind.port}
  83.                 offSizeH, offSizeV: integer;                    {*Offscreen size, used to limit sprite positions}
  84.                 offScreen: SATPort;                            {*Offscreen image }
  85.                 backScreen: SATPort;                        {*Background image }
  86.  
  87.                 ox, oy: longint;                                {Internal}
  88.                 pict, bwpict: integer;                        {PICT id's}
  89.                 fitThePICTs: boolean;                        {Resize PICTs to fit?}
  90.                 sorting: integer;                                {Chosen sorting}
  91.                 collision: integer;                            {Chosen collision handling}
  92.                 searchWidth: integer;                        {Chosen search width}
  93.                 screen: PixMapHandle;                        {Internal}
  94.                 bounds: Rect;                                    {Internal}
  95.                 initDepth: Integer;                            {*Depth at last icon initialization}
  96.                 synchHook: ProcPtr;                            {Synch procedure}
  97.                 sRoot: SpritePtr;                                {Sprite list root}
  98.                 updateRoot: UpdatePtr;                        {Update list root}
  99.                 anyMonsters: Boolean;                        {*False when no sprites with kind < -1 are active }
  100.  
  101.                 ditherOff: CGrafPtr;                            {Internal}
  102.                 ditherOffGD: GDHandle;                        {Internal}
  103.                 iconPort: SATPort;                            {Internal}
  104.                 iconPort2: SATPort;                            {Internal}
  105.                 bwIconPort: GrafPtr;                         {Internal}
  106. {Environment-independent globals:}
  107.                 faceRoot: FacePtr;                            {Root of face list}
  108.                 colorFlag: Boolean;                            {True if color QuickDraw is available.}
  109.                 mmuMode: SignedByte;                        {Addressing mode}
  110. {Blitters! You should not change these fields yourself. (Possibly for installing a blitter in your program code.)}
  111.                 rectBlit1, maskBlit1: ProcPtr;                {Supplied - this is either RBlt/MBlt 0 or 1}
  112.                 rectBlit2, maskBlit2: ProcPtr;                {Will probably never be used}
  113.                 rectBlit4, maskBlit4: ProcPtr;                {Supplied}
  114.                 rectBlit8, maskBlit8: ProcPtr;                {Supplied}
  115.                 rectBlit16, maskBlit16: ProcPtr;            {Not supplied}
  116.                 rectBlit32, maskBlit32: ProcPtr;            {Not supplied}
  117.                 curRectBlit, curMaskBlit: ProcPtr;            {Currently selected fast blitter}
  118.                 screenLocalDrawingArea: Rect;
  119.                 trashList: SpritePtr;
  120.             end;
  121.  
  122. {Configuration types: VPositionSort and KindCollision are defaults.}
  123.     const
  124. {Sorting options}
  125.         kVPositionSort = 0;
  126.         kLayerSort = 1;
  127.         kNoSort = 2;
  128. {Collision detection options}
  129.         kKindCollision = 0;
  130.         kForwardCollision = 1;
  131.         kBackwardCollision = 2;
  132.         kNoCollision = 3;
  133.         kForwardOneCollision = 4;
  134.  
  135.     var
  136. {$ifc UNDEFINED THINK_PASCAL}
  137.         gSAT: SATglobalsRec;
  138.         external;                            {Most globals in a record. See above.}
  139.         gSATSoundErrorProc: ProcPtr;
  140.         external;                            {Pointer to procedure to call on sound error.}
  141. {$elsec}
  142. {$J+}
  143.         gSAT: SATglobalsRec;                {Most globals in a record. See above.}
  144.         gSATSoundErrorProc: ProcPtr;        {Pointer to procedure to call on sound error.}
  145. {$J-}
  146. {$endc}
  147.  
  148. {Initializing and customizing}
  149.     procedure SATConfigure (PICTfit: boolean; newSorting, newCollision, searchWidth: integer);
  150.     procedure SATInit (pictID, bwpictID, Xsize, Ysize: integer);
  151.     procedure SATCustomInit (pictID, bwpictID: integer; var SATdrawingArea: Rect; {}
  152.                                     preloadedWind: WindowPtr; chosenScreen: GDHandle; useMenuBar, {}
  153.                                     centerDrawingArea, fillScreen, dither4bit, beSmart: Boolean);
  154. {Maintainance, background manipulation etc.}
  155.     function SATDepthChangeTest: Boolean;
  156.     procedure SATDrawPICTs (pictID, bwpictID: integer);
  157.     procedure SATRedraw;
  158. {Drawing}
  159.     procedure SATPlotFace (theFace: FacePtr; theGrafPtr: SATPortPtr; where: Point; Fast: boolean);
  160.     procedure SATPlotFaceToScreen (theFace: FacePtr; where: Point; Fast: boolean);
  161. {SATCopybits is now only done with a CopyBits - so it's really obsolete.}
  162.     procedure SATCopyBits (src, dest: SATPortPtr; {}
  163.                                     var srcRect, destRect: Rect; fast: Boolean);
  164.     procedure SATCopyBitsToScreen (src: SATPortPtr; var srcRect, destRect: Rect; fast: Boolean);
  165.     procedure SATBackChanged (var r: Rect); {Tell SAT about changes in backScreen}
  166. {SetPort replacements}
  167.     procedure SATGetPort (var port: SATPort);
  168.     procedure SATSetPort (var port: SATPort);
  169.     procedure SATSetPortOffScreen; {Use before using QuickDraw on offScreen}
  170.     procedure SATSetPortBackScreen; {Use before using QuickDraw on backScreen}
  171.     procedure SATSetPortScreen; {Use to set port to gSAT.wind}
  172. {Basic sprite handling}
  173.     function SATGetFace (resNum: integer): FacePtr;
  174.     procedure SATDisposeFace (theFace: FacePtr);
  175.     function SATNewSprite (kind, hpos, vpos: integer; setup: ProcPtr): SpritePtr;
  176.     function SATNewSpriteAfter (afterthis: SpritePtr; kind, hpos, vpos: integer; setup: ProcPtr): SpritePtr;
  177.     procedure SATKillSprite (who: Spriteptr);
  178. {Animating}
  179.     procedure SATRun (fast: Boolean); {The heart of the whole package!}
  180.     procedure SATRun2 (fast: Boolean); {Alternate routine for allowing resting sprites}
  181. {Special functions for advanced programmers}
  182.     procedure SATInstallSynch (theSynchProc: ProcPtr);
  183.     procedure SATInstallEmergency (theEmergencyProc: ProcPtr);
  184.     procedure SATSetSpriteRecSize (theSize: longint);
  185.     procedure SATSkip;
  186.     procedure SATKill; {Dispose of offscreen buffers to allow re-init}
  187.     procedure SATWindMoved;
  188. {Offscreen - use only if you need an *extra* offscreen buffer. These calls are likely to change in the future!}
  189.     procedure SATMakeOffscreen (var portP: SATPort; var rectP: Rect); {Make offscreen buffer in current screen depth and CLUT.}
  190.     procedure SATDisposeOffScreen (var portP: SATPort); {Get rid of offscreen}
  191.     function CreateOffScreen (var bounds: Rect; depth: Integer; colors: CTabHandle; var retPort: CGrafPtr; var retGDevice: GDHandle): OSErr; {From Principia Offscreen - color only}
  192.     procedure DisposeOffScreen (doomedPort: CGrafPtr; doomedGDevice: GDHandle);{From Principia Offscreen - color only}
  193. {Face manipulation (for advanced programmers)}
  194.     procedure SATSetPortMask (theFace: FacePtr);
  195.     procedure SATSetPortFace (theFace: FacePtr);
  196.     procedure SATSetPortFace2 (theFace: FacePtr);
  197.     function SATNewFace (var faceBounds: Rect): FacePtr;
  198.     procedure SATChangedFace (theFace: FacePtr);
  199.  
  200. {New procedures, EXPERIMENTAL, intended for making a C++ interface}
  201.     function SATGetFacePP (resNum: integer; fStorage: Ptr): FacePtr;
  202.     function SATNewSpritePP (afterthis: SpritePtr; sStorage: Ptr; theKind, hpos, vpos: integer; setup: ProcPtr): SpritePtr;
  203.     procedure SATCopySprite (destSprite: SpritePtr; srcSprite: SpritePtr);
  204.     function SATNewFacePP (var faceBounds: Rect; fStorage: Ptr): FacePtr;
  205.     procedure SATCopyFace (destFace: FacePtr; srcFace: FacePtr);
  206.     procedure SATDisposeFacePP (theFace: FacePtr);
  207.  
  208. {Cicn utilities}
  209.     function SATGetCicn (cicnId: integer): CIconHandle;
  210.     procedure SATPlotCicn (theCicn: CIconHandle; dest: GrafPtr; destGD: GDHandle; var r: Rect); {Borde jag lägga till device?}
  211.     procedure SATDisposeCicn (theCicn: CIconHandle);
  212.  
  213. {Utilities}
  214.     procedure SATSetStrings (ok, yes, no, quit, memerr, noscreen, nopict, nowind: Str255);
  215.     function SATTrapAvailable (theTrap: Integer): Boolean;
  216.     procedure SATDrawInt (i: integer);
  217.     procedure SATDrawLong (l: longint);
  218.     function SATRand (n: integer): integer;
  219.     function SATRand10: integer;
  220.     function SATRand100: integer;
  221.     procedure SATReportStr (str: str255);
  222.     function SATQuestionStr (str: str255): Boolean;
  223.     function SATFakeAlert (s1, s2, s3, s4: Str255; nButtons, defButton, cancelButton: integer;{}
  224.                                     t1, t2, t3: Str255): integer;
  225.     procedure CheckNoMem (p: Ptr); {If the Ptr is nil, out of memory emergency exit}
  226.     procedure SATSetMouse (where: point);
  227.     procedure SATInitToolbox;
  228.     procedure SATGetVersion (var versionString: Str255);
  229. {Pattern utilities}
  230.     procedure SATPenPat (SATpat: SATPatHandle);
  231.     procedure SATBackPat (SATpat: SATPatHandle);
  232.     function SATGetPat (patID: integer): SATPatHandle;
  233.     procedure SATDisposePat (SATpat: SATPatHandle);
  234. {Menu bar utilities}
  235.     procedure SATShowMBar (wind: WindowPtr);
  236.     procedure SATHideMBar (wind: WindowPtr);
  237. {PICT utilities}
  238.     procedure SATGetandDrawPICTRes (id: integer);
  239.     procedure SATGetandDrawPICTResInRect (id: integer; var frame: Rect);
  240.     procedure SATGetandCenterPICTResInRect (id: integer; var frame: Rect);
  241. {Sound}
  242.     procedure SATSoundInit; {Called from SATInit}
  243.     procedure SATSoundPlay (theSound: Handle; priority: Integer; canWait: Boolean);
  244.     procedure SATSoundEvents; {Call this once in a while when not calling SATRun often}
  245.     procedure SATSoundShutup; {Silence, dispose of sound channel}
  246.     procedure SATSoundOn;
  247.     procedure SATSoundOff;
  248.     function SATSoundDone: Boolean; {Any sound going on ?}
  249.     function SATGetSound (sndId: Integer): Handle;        { To load a sound and get a handle for SATSoundPlay }
  250.     function SATGetNamedSound (name: Str255): Handle; { Same but using resource names }
  251.     procedure SATDisposeSound (theSnd: handle);
  252. {Multi-channel sound routines}
  253.     function SATSoundInitChannels (num: integer): integer;
  254.     function SATSoundDoneChannel (chanNum: integer): Boolean;
  255.     procedure SATSoundPlayChannel (theSound: Handle; chanNum: integer);
  256.     procedure SATSoundReserveChannel (chanNum: integer; reserve: Boolean);
  257.     procedure SATSoundShutupChannel (chanNum: integer);
  258.     procedure SATPreloadChannels;
  259. {Experimental, likely to be renamed/removed/changed:}
  260.     procedure SATSoundPlay2 (theSound: Handle; priority: integer; canWait, skipIfSame: Boolean);
  261.     procedure SATSoundPlayEasy (theSound: Handle; canWait: Boolean);
  262. {More multi-channel:}
  263.     function SATGetNumChannels: integer;
  264.     function SATGetChannel (chanNum: integer): Ptr;
  265. {Customization}
  266.     procedure SATSetSoundInitParams (params: Longint);
  267.  
  268. {Step-scrolling}
  269.     function SATStepScroll (viewPoint: Point; marginH, marginV, scrollSpeed: Integer): Boolean;
  270.  
  271. {$ifc UNDEFINED THINK_PASCAL}
  272. {$ALIGN RESET}
  273. {$POP}
  274. {$endc}
  275.  
  276. implementation
  277. end.